home *** CD-ROM | disk | FTP | other *** search
/ AGA Toolkit '97 / The AGA Toolkit '97.iso / miscellaneous / help / dos / dosman / man / filenote < prev    next >
Encoding:
Text File  |  1996-09-07  |  2.4 KB  |  79 lines
  1.  
  2.  
  3.  
  4.             Filenote(V1.3, 2.x, 3.x in C:)
  5.  
  6.  
  7.  
  8.      NAME
  9.             Filenote - Sets a comment for a file.
  10.  
  11.      SYNOPSIS
  12.             Filenote [File]filename Comment
  13.  
  14.      DESCRIPTION
  15.             You can set a comment for a file of up to 79 
  16.         characters using this command.  You can also remove the 
  17.         comment for a file using this command by specifying a 
  18.         null comment string.  Comments may be viewed with the 
  19.         list command.
  20.  
  21.             When you COPY a file, the note does not get copied 
  22.         with it.  When you RENAME a file, the note stays attached 
  23.         to that file.  If you change the file in any way, except 
  24.         COPYing it, the file note does not get effected. If you 
  25.         add another filenote to a a file that already has one, 
  26.         then the old one gets deleted and the new one replaces 
  27.         it.
  28.  
  29.             If you LIST a directory, these filenotes are 
  30.         displayed. The notes will appear right below the file 
  31.         name with a : in front of it.  If there is an icon 
  32.         attached to that file, then you can read or write a note 
  33.         through that icon's information window.
  34.  
  35.             These filenotes do not effect the file they are 
  36.         attached to in anyway what so ever.
  37.  
  38.      KEYWORDS
  39.         FILE filename
  40.             This is the file the note is to be attached to. If this is 
  41.         the first argument in the command string then the FILE keyword is
  42.         optional. 
  43.  
  44.             1.3 only: Only one file can be annotated at a time.
  45.  
  46.             2.x/3.x only: Wildcards are completely acceptable. 
  47.         You can also annotate as many files as you like at the 
  48.         same time.
  49.  
  50.  
  51.         COMMENT string
  52.             If this is the second argument in the command string then the
  53.         COMMENT keyword is optional. This defines the note that is to be
  54.         attached to it. The string must be enclosed in quotation.
  55.  
  56.         ALL
  57.             2.x/3.x only: Lets you add the same note to all the files in
  58.         the specified directory and all its subdirectories.
  59.  
  60.         QUIET
  61.             2.x/3.x only: Does not list the files as the notes are being
  62.         added.
  63.  
  64.      EXAMPLE
  65.           
  66.             1. To attach a note that says "Here it is!" to your 
  67.         file ThisFile
  68.  
  69.           Filenote FILE ThisFile COMMENT "Here it is!" 
  70.  
  71.             2. To attach a note that says "Don't delete this no 
  72.         matter what!" to the File Important.text
  73.  
  74.           Filenote Important.text "Don't delete this no matter what!"
  75.  
  76.  
  77.      SEE ALSO
  78.           Copy List
  79.